Skip to main content
GET
[VPC IPs] Get IP allocation details

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

id
string<uuid>
required

A UUID string identifying this VPC IP Allocation.

organization_id
string<uuid>
required
project_id
string<uuid>
required
vpc_id
string<uuid>
required

Response

200 - application/json
id
string<uuid>
required
read-only
vpc_id
string<uuid>
required
read-only
vpc_name
string
required
read-only
ip_address
string
required
read-only
instance_id
string<uuid> | null
required
read-only
instance_name
string | null
required
read-only
status
enum<string>
required
read-only
  • reserved - Reserved
  • allocated - Allocated
  • released - Released
Available options:
reserved,
allocated,
released
allocation_type
enum<string>
required
read-only
  • gateway - Gateway
  • instance - Instance
Available options:
gateway,
instance
interface_index
integer
required
read-only

Network interface index (1=net1, 2=net2, etc.)

allocated_at
string<date-time>
required
read-only
released_at
string<date-time> | null
required
read-only
created
string<date-time>
required
read-only
modified
string<date-time>
required
read-only